gh-142918: Fix Context docstrings to say iterator instead of list#143266
Closed
sandole wants to merge 1 commit intopython:mainfrom
Closed
gh-142918: Fix Context docstrings to say iterator instead of list#143266sandole wants to merge 1 commit intopython:mainfrom
sandole wants to merge 1 commit intopython:mainfrom
Conversation
The Context.items(), Context.keys(), and Context.values() methods return iterators, not lists. Updated the docstrings in both the C source and the documentation to accurately reflect this behavior. Files modified: - Python/context.c: Updated clinic input docstrings - Python/clinic/context.c.h: Regenerated by clinic tool - Doc/library/contextvars.rst: Updated documentation
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
Contributor
|
Hi, there is already an open PR for the original issue (with almost the same changes): #142919 . Please check whether there is already work in progress on an issue before starting to work on it, to reduce unnecessary duplication of effort. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Context.items(), Context.keys(), and Context.values() methods return iterators, not lists. Updated the docstrings in both the C source and the documentation to accurately reflect this behavior.
Files modified:
📚 Documentation preview 📚: https://cpython-previews--143266.org.readthedocs.build/